 Rad-M Help Index

First Time Users

Quick Start

Commands

File menu

View menu

Document menu

Administration menu

Help menu

User How To...

Use an HTML-Compiling editor

Import Existing Documents

Include Graphics in Documents

Administrator How To...

Assigning a new document to a user


File menu commands

The File menu offers the following commands:

New	Creates a new document set.
Open	Opens an existing document set.
Close	Closes an opened document set.
Save	Saves an opened document set using the same file name.
Save As	Saves an opened document set to a specified file name.
Options	Sets up details associated with the current document set.
Preferences	Sets up your personal editing and browsing preferences and any administration details.
Exit	Exits Rad-M.


View menu commands

The View menu offers the following commands:

Toolbar	Shows or hides the toolbar.
Status Bar	Shows or hides the status bar.


Document menu commands

The Document menu offers the following commands:

Edit	Edits the selected document in your HTML editor.
Test	Tests the selected document in your HTML browser.
Install	Installs the selected document on the server machine.
Properties	Changes properties on the selected document. Name, server and description can be changed.
Add	Adds a new document your list of managed documents.
Delete	Deletes a document from your list of managed documents.
Give	Gives a document to another user to manage.


Administration menu commands

The Administration menu offers the following commands:

Document Check	Checks to see if any more documents have been assigned to you.
Graphics Library	Browses the graphics library.
Import Local Graphics	Imports a graphic file for use within a document.


Help menu commands

The Help menu offers the following commands, which provide you assistance with this application:

Index	Offers you an index to topics on which you can get help.
Using Help	Provides general instructions on using help.
About	Displays the version number of this application.


File New command
New command (File menu)

Use this command to create a new document set in Rad-M.

You can open an existing document set with the Open command.

Shortcuts

Toolbar:

Keys:	CTRL+N


File Open command
Open command (File menu)

Use this command to open an existing document set.

You can create new document sets with the New command.

Shortcuts

Toolbar:

Keys:	CTRL+O


File Open dialog box

The following options allow you to specify which file to open:

File Name

Type or select the filename you want to open.  This box lists files with the extension you select in the List Files of Type box.

Drives

Select the drive in which Rad-M stores the file that you want to open.

Directories

Select the directory in which Rad-M stores the file that you want to open.

Network...

Choose this button to connect to a network location, assigning it a new drive letter.


File Close command
Close command (File menu)

Use this command to close the active document set.

You can also close a document by using the Close icon on the document's window, as shown below:


File Save command
Save command (File menu)

Use this command to save the active document set to its current name and directory.  When you save a document set for the first time, Rad-M displays the Save As dialog box so you can name your document set.  If you want to change the name and directory of an existing document set before you save it, choose the Save As command.

Rad-M performs automatic saves of your document set at various points so you should not need to save at all after the initial creation.

Shortcuts

Toolbar:

Keys:	CTRL+S


File Save As command
Save As command (File menu)

Use this command to save and name the active document set.  Rad-M displays the Save As dialog box so you can name your document set.

To save a document set with its existing name and directory, use the Save command.


File Save As dialog box

The following options allow you to specify the name and location of the file you're about to save:

File Name

Type a new filename to save a document with a different name.  A filename can contain up to eight characters and an extension of up to three characters.  Rad-M adds the extension .rad

Drives

Select the drive in which you want to store the document.

Directories

Select the directory in which you want to store the document.

Network...

Choose this button to connect to a network location, assigning it a new drive letter.


File, Options command
Options (File menu)

This option will bring up a dialog box to allow you to change the details of the current document set.

You should specify information here which is the same for all the documents in your set. This saves you from entering the same information for each document in the set.

If your documents are all stored under your account name, specify your account name here. If your password is the same for all your document accounts, you may (*) specify your password here. If your documents are all stored on the same server, specify your server name here.

(*) It is recommended that you do not specify your password here, in which case it will be asked for wherever required during document editing operations. If you specify it here, other people will be able to edit your documents from your unattended PC without having to know your password.

If all your documents are stored in the same directory, you can specify that directory here. Similarly, if they are all stored somewhere beneath a common directory, you can specify the common bit of the directory path here and the rest of the path on a per document basis. eg. Documents c:\web\gary\mydoc.htm and c:\web\info\sales.htm. You can specify c:\web here. (Then, later, you would specify gary\mydoc.htm and info\sales.htm)


File, Preferences command
User Preferences (File menu)

This option will bring up a dialog box to allow you to change your personal preferences.

Specify your browser first. It could be Netscape, Mosaic, Internet Explorer, etc. Type the full filename of the .exe file or use the Find button to navigate to it.

Specify your Document Editor next. This could be Notepad, Hot Metal, HotDog, Microsoft Word with some Internet add on, etc.

If the Document Editor you selected just edits HTML files, (Notepad, HotMetal, Hotdog, MS Word and Internet Assistant, etc) turn the next option off. If, however, the Document Editor edits .DOC files or .RTF files or similar and generates the HTML from these after every edit (MS Word and Internet Author, etc), turn this option on and fill in the document type (DOC or RTF) For more details, see section on Using a HTML-Compiling editor.

Specify a template file next that will be used when you create and edit a new document. If you want to start each document off from scratch, leave this blank. Otherwise, some templates are shipped with Rad-M and should be in the radm directory. You may like to use one of these. NOTE when using HTML-Compiling editors: The template should be of the same type as the source document. (.DOC or .RTF, etc)

Finally, Rad-M can be used as part of a full-scale documentation system. This system will be administered from an account on a remote server and you can specify this account information here. If you have a system administrator, consult him/her for details. Otherwise, leave this blank.


Document, Edit command
Edit (Document menu)

This option will bring up your configured editor and place the currently selected document into it. If the document is remote, the document will first be transferred from the server to the local machine.

If you have a file locally called updating.htm, the file on the server will be replaced by this file. In this way, you can specify that when a file is edited, other users who try to read it off the server will be presented instead with your updating document.

You may wish to include a message in your local updating.htm document such as This document is currently being updated. Please try later.


Document, Test command
Test (Document menu)

Rad-M can cater for document editors are not fully WYSIWYG ie. the edited document may look slightly different when it has been installed on the server and is being read by other users in the browser than it does when it is being edited by you in your document editor.

It does this by allowing you to test out your edited document before submitting it back to the server.

The document must be local to perform a test.

When the test option is selected, the document will be displayed in your configured browser. NOTE: This is a test of the look and feel of the document. The hyperlinks will not work until the document is installed on the server.


Document, Install command
Install (Document menu)

This option installs the currently selected document on its home server. All referenced pictures are also installed automatically.

When the document is installed, all users can access it immediately (As long as they have required security permissions).

The document and associated graphics are removed from the local disk after they have been installed.


Document, Properties command
Properties (Document menu)

This option shows all details on the currently selected document.

The Description field is the title of the document that appears in the Rad-M window and can be set to any description required by the user without affecting the operation of the program.

NOTE: All following information is only available in the administration of Rad-M.

The File Name field contains the file and path name of the document as it exists when it is remote on the server. If many of the documents in the set share the same path name, the Options section may be used to specify the path name and this box would just specify the filename (and possibly any lower directories)

The Server Details box contains the server name and account details where the document is stored when it is remote.

The Local flag indicates whether the document is currently local or not. (That is, on the local machine)


Document, Add command
Add (Document menu)

This option will bring up a dialog box to allow you to add a new document to current document set. (Administration Version Only)

You should first specify a description of the document to come up in the main Rad-M window. eg. Sales forecast for early 1996

Next, you must specify where the document is stored when it is remote. This information consists of a path name, a server name, an account name and an account password (*). The account name and password default to the values in the Optionsdialog box. You can override these default values by modifying them here.

The path of the document must be the path of the HTML document and so should end with .htm or .html. This is regardless of whether you are using a HTML-compiling editor or not.

(*) It is recommended that you do not specify your password here, in which case it will be asked for wherever required during document editing operations. If you specify it here, other people will be able to edit your documents from your unattended PC without having to know your password.

The path name you specify for the document will be appended to the path name specified in the Web Root Path of the Options dialog, if there is one.

If the document already exists on the server and you are just adding it to your document set, remove the tick from the local box. If it does not exist yet, leave the local box ticked.


Document, Delete command
Delete (Document menu)

This option will allow you to remove the currently selected document from the current document set. (Administration Version Only)

Before deleting the document, confimation will be asked for.


Document, Give command
Give (Document menu)

This option will allow you to give the currently selected document to another user to manage. When this option is selected, the document will disappear from your Rad-M and will reappear in the nominated users Rad-M when they next do a document check.

The document must be Remote for you to give it away.


Administration, Document Check command
Document Check (Administration menu)

This option will check to see if the administrator has assigned you any more documents to manage.

When you select this option, a message is sent to the admin account specified in the File / User Preferences menu. If any documents are specified there, they will appear in the main Rad-M window.

If no documents are found, a window will appear asking you to Retry or Cancel the operation.


Administration, Graphics Library command
Graphics Library (Administration menu)

This option will first look up the location of the graphics library from the administrator account. Then a list of all graphics in the library will be thrown up in your selected browser application.

You can preview each graphic by clicking on it.

To use a graphic from the library in your documents, first preview the graphic. Then ensure that the URL is visible in your browser. For example, in Netscape, it looks like this:

Bring up the document into which you wish to insert the graphic in your editor and using COPY (CTL-C) and PASTE (CTL-V), insert the URL into the document under the insert graphic option. For example, in MS Word:

NOTE: The graphic will not be available to the document so if the editor tries to display the graphic, it may come up as an empty box or some such. To see the graphic in situ, use the test document menu item after saving away the document from the editor.


Graphics, Importing local
Import Local Graphics (Administration menu)

To include local graphics with your document, you must place them in the same directory as your Rad file. When a document is sent to a server, all included graphics within the same directory are sent with it.

This option allows you to specify a graphic file anywhere on your local computer to be included into a document you are editing.

For example, if you have a .gif file on a floppy disk that you wish to include in one of your documents, edit the document by double clicking on it. Minimise the edit session and, from Rad-M, select Import Local Graphics. A file selection box will come up and you should find your gif on the floppy and double click on it.

You can then go back to your document editor and insert the image into the document.

(What the option actually does is to take a copy of the graphic file into the same directory as the Rad file. If it is already there, there is no point doing this operation.)


Importing Existing Documents

If you are importing a document that already exists on a server or you have the user version of Rad-M, consult the server administrator or administrator documentation.

If you are importing a document that is on your client machine, copy the document and any in-line graphics into the rad working directory. Select Add from the Document menu and type in details of the document. The document be selected as a local document. You should then be able to edit, test and install the document onto the server.

A further problem may occur if you have elected to use a compiling HTML editor and are trying to import a raw HTML document. In this case, where the editors native document is not HTML but some other format, you must reconstruct the document, perhaps using cut and paste, in the native format.

As an example, if you have a HTML document and you wish to use HTML Author and MS-Word to update it, you should create a new document in MS-Word based in the HTML Author template, cut and paste the HTML document into it, perhaps redoing the Headers and inline pictures, and save it away under the same name but with .DOC on the end. Then re-generate the HTML and carry on as normal.


Using a HTML Compiling Editor

There are two types of editors for Web documents (known as HTML format documents)

1.	Editors that read in the HTML document and allow you to edit it and save it away,

2.	Editors that work in their own format but allow you to compile a HTML document after editing. The difference with this type of editor is that the HTML file cannot be read back in and you must go back to the editors format of document to modify the file.

Rad-M supports both types. The supplied editor is an extension to Microsoft Word called HTML Author. It is of the second type and works natively in MS Word .DOC files.

To integrate with this type of editor, you must select the Preferences option in the File menu and ensure that the box is selected before Generates HTML from type. In the box afterwards, you must specify the editors native type 3 letter extension which in the case of HTML Author is DOC.


Assigning a new document to a user

If you have the administration version of Rad-M, you can assign new documents to users whether you are running on the server or on a client.

First, add the document to your list of current documents. You can select what it will be called, where it should reside on the server, etc. Ensure the document is created as Remote (That is, the Local flag is turned OFF)

Then, select that document and use the Give command. Type in the name of the user to give this document to and click ok. The document should disappear from your list of currently managed documents and will appear on the list of the user when he/she next does a document check.


Including graphics in a document

There are two types of graphics you can include in your document.

A graphic can be pulled in from a graphics library, usually set up by your administrator. You access these graphics from the Graphics Library menu item in Rad-M. When you are editing your document, it is probable that these graphics wont be displayed.

Alternatively, if you have a graphic file on a floppy disk or on your hard disk, you can include it in your document as a local graphic. To do this, you should use the import_local graphic menu item. This type of graphic will probably be displayed when you are editing your document.

When you are testing your document, both types of graphic should appear. If they do not, there is a problem and you should consult your network administrator.

When you download your document from the server, all local graphics are downloaded with it. Note that all library graphics are not.


A quick start walkthrough
Quick Start

- Start up Rad-M.

- Specify how you want to manage your documents - Select the [File/User Preferences] menu and fill in any details. See Preferences.

- Create a new document set - Select the [File/Save As] menu and type mydocset.rad

- Specify any details about this set of documents - Select the [File/Options] menu and fill in any details. See Options.

- Add your first document - Select the [Document/Add] menu and fill in any details. See add.

Now you are set up and ready to go.

- Edit the document.

- Save away the changes and quit your editor.

- Test your document.

- If you are happy with it, Install it to the server.


File 1, 2, 3, 4 command
1, 2, 3, 4 command (File menu)

Use the numbers and filenames listed at the bottom of the File menu to open the last four documents you closed.  Choose the number that corresponds with the document you want to open.


File Exit command
Exit command (File menu)

Use this command to end your Rad-M session.  You can also use the Close command on the application Control menu.

Shortcuts

Mouse:	Double-click the application's Control menu button.

Keys:	ALT+F4


View Toolbar command
Toolbar command (View menu)

Use this command to display and hide the Toolbar, which includes buttons for some of the most common commands in Rad-M, such as File Open.  A check mark appears next to the menu item when the Toolbar is displayed.

See Toolbar for help on using the toolbar.


Toolbar

The toolbar is displayed across the top of the application window, below the menu bar.  The toolbar provides quick mouse access to many tools used in Rad-M,

To hide or display the Toolbar, choose Toolbar from the View menu (ALT, V, T).

Click	To

Open a new document.

Open an existing document.  Rad-M displays the Open dialog box, in which you can locate and open the desired file.

Save the active document or template with its current name.  If you have not named the document, Rad-M displays the Save As dialog box.


View Status Bar Command
Status Bar command (View menu)

Use this command to display and hide the Status Bar, which describes the action to be executed by the selected menu item or depressed toolbar button, and keyboard latch state. A check mark appears next to the menu item when the Status Bar is displayed.

See Status Bar for help on using the status bar.


Status Bar

The status bar is displayed at the bottom of the Rad-M window.  To display or hide the status bar, use the Status Bar command in the View menu.

The left area of the status bar describes actions of menu items as you use the arrow keys to navigate through menus.  This area similarly shows messages that describe the actions of toolbar buttons as you depress them, before releasing them.  If after viewing the description of the toolbar button command you wish not to execute the command, then release the mouse button while the pointer is off the toolbar button.

The right areas of the status bar indicate which of the following keys are latched down:

Indicator	Description

CAP	The Caps Lock key is latched down.

NUM	The Num Lock key is latched down.

SCRL	The Scroll Lock key is latched down.


Index command (Help menu)

Use this command to display the opening screen of Help.  From the opening screen, you can jump to step-by-step instructions for using Rad-M and various types of reference information.

Once you open Help, you can click the Contents button whenever you want to return to the opening screen.


Using Help command (Help menu)

Use this command for instructions about using Help.


About command (Help menu)

Remote

Access

Document

Management

(C) 1995 Unidec Systems Limited


Help Using Help Command
Context Help command

Use the Context Help command to obtain help on some portion of Rad-M.  When you choose the Toolbar's Context Help button, the mouse pointer will change to an arrow and question mark.  Then click somewhere in the Rad-M window, such as another Toolbar button.  The Help topic will be shown for the item you clicked.

Shortcut

Keys:	SHIFT+F1


Title Bar

The title bar is located along the top of a window.  It contains the name of the application and document.

To move the window, drag the title bar.  Note: You can also move dialog boxes by dragging their title bars.

A title bar may contain the following elements:

Application Control-menu button

Document Control-menu button

Maximize button

Minimize button

Name of the application

Name of the document

Restore button


Scroll bars

Displayed at the right edge of the document window.  The scroll boxes inside the scroll bar indicate your vertical location in the document.  You can use the mouse to scroll to other parts of the document.


Size command (System menu)

Use this command to display a four-headed arrow so you can size the active window with the arrow keys.

After the pointer changes to the four-headed arrow:

1.	Press one of the DIRECTION keys (left, right, up, or down arrow key) to move the pointer to the border you want to move.

2.	Press a DIRECTION key to move the border.

3.	Press ENTER when the window is the size you want.

Note:  This command is unavailable if you maximize the window.

Shortcut

Mouse:	Drag the size bars at the corners or edges of the window.


Move command (Control menu)

Use this command to display a four-headed arrow so you can move the active window or dialog box with the arrow keys.

Note:  This command is unavailable if you maximize the window.

Shortcut

Keys:	CTRL+F7


System Minimize Command
Minimize command (application Control menu)

Use this command to reduce the Rad-M window to an icon.

Shortcut

Mouse:	Click the minimize icon [image] on the title bar.

Keys:	ALT+F9


Maximize command (System menu)

Use this command to enlarge the active window to fill the available space.

Shortcut

Mouse:	Click the maximize icon [image] on the title bar; or double-click the title bar.

Keys:	CTRL+F10 enlarges a document window.


Next Window command (document Control menu)

Use this command to switch to the next open document window.  Rad-M determines which window is next according to the order in which you opened the windows.

Shortcut

Keys:	CTRL+F6


Previous Window command (document Control menu)

Use this command to switch to the previous open document window.  Rad-M determines which window is previous according to the order in which you opened the windows.

Shortcut

Keys:	SHIFT+CTRL+F6


Close command (Control menus)

Use this command to close the active window or dialog box.

Double-clicking a Control-menu box is the same as choosing the Close command.

Shortcuts

Keys: 	CTRL+F4 closes a document window

ALT+F4 closes the rad window or dialog box


Restore command (Control menu)

Use this command to return the active window to its size and position before you chose the Maximize or Minimize command.


Switch to command (application Control menu)

Use this command to display a list of all open applications.  Use this "Task List" to switch to or close an application on the list.

Shortcut

Keys:	CTRL+ESC

Dialog Box Options

When you choose the Switch To command, you will be presented with a dialog box with the following options:

Task List

Select the application you want to switch to or close.

Switch To

Makes the selected application active.

End Task

Closes the selected application.

Cancel

Closes the Task List box.

Cascade

Arranges open applications so they overlap and you can see each title bar.  This option does not affect applications reduced to icons.

Tile

Arranges open applications into windows that do not overlap.  This option does not affect applications reduced to icons.

Arrange Icons

Arranges the icons of all minimized applications across the bottom of the screen.


No Help Available

No help is available for this area of the window.


No Help Available

No help is available for this message box.